package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SalaryPlanFormulaAddDTO;
import org.jsola.hr.dto.SalaryPlanFormulaBatchDTO;
import org.jsola.hr.dto.SalaryPlanFormulaUpdateDTO;
import org.jsola.hr.query.SalaryPlanFormulaQuery;
import org.jsola.hr.vo.SalaryPlanFormulaListVO;
import org.jsola.hr.vo.SalaryPlanFormulaVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-工资方案计算公式及条件")
public interface ISalaryPlanFormulaControllerAPI {

    /**
     * 新增工资方案计算公式及条件
     * @param salaryPlanFormulaAddDTO 工资方案计算公式及条件新增实体
     * @return 工资方案计算公式及条件展示对象
     */
    @ApiOperation(value = "新增工资方案计算公式及条件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryPlanFormulaAddDTO", dataType = "SalaryPlanFormulaAddDTO", value = "新增工资方案计算公式及条件", paramType = "body")
    })
    Result<SalaryPlanFormulaVO> save(SalaryPlanFormulaAddDTO salaryPlanFormulaAddDTO);


    /**
     * 修改工资方案计算公式及条件
     * @param salaryPlanFormulaUpdateDTO 工资方案计算公式及条件
     * @return 更新数量
     */
    @ApiOperation(value = "修改工资方案计算公式及条件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryPlanFormulaUpdateDTO", dataType = "SalaryPlanFormulaUpdateDTO", value = "修改工资方案计算公式及条件", paramType = "body")
    })
    Result<Integer> update(SalaryPlanFormulaUpdateDTO salaryPlanFormulaUpdateDTO);

    /**
     * 批量编辑、新增、删除工资方案计算公式及条件
     * @param salaryPlanFormulaBatchDTO 要操作的工资方案计算公式及条件
     * @return 操作之后的全部工资方案计算公式及条件
     */
    @ApiOperation(value = "批量编辑、新增、删除工资方案计算公式及条件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryPlanFormulaBatchDTO", dataType = "SalaryPlanFormulaBatchDTO", value = "要操作的字段数据", paramType = "body")
    })
    Result batch(SalaryPlanFormulaBatchDTO salaryPlanFormulaBatchDTO);



    /**
     * 删除单个工资方案计算公式及条件，彻底删除
     * @param salaryPlanFormulaId 工资方案计算公式及条件id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个工资方案计算公式及条件，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryPlanFormulaId", dataType = "String", value = "工资方案计算公式及条件id", paramType = "path")
    })
    Result<Integer> delete(String salaryPlanFormulaId);


    /**
     * 批量删除工资方案计算公式及条件，彻底删除
     * @param salaryPlanFormulaIds 工资方案计算公式及条件id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除工资方案计算公式及条件，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryPlanFormulaIds", dataType = "String[]", value = "工资方案计算公式及条件id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] salaryPlanFormulaIds);


    /**
     * 根据工资方案计算公式及条件id查询工资方案计算公式及条件详情
     * @param salaryPlanFormulaId 工资方案计算公式及条件id
     * @return 工资方案计算公式及条件详情
     */
    @ApiOperation(value="根据工资方案计算公式及条件id查询工资方案计算公式及条件详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryPlanFormulaId", dataType = "String", value = "工资方案计算公式及条件id", paramType = "path")
    })
    Result<SalaryPlanFormulaVO> findById(String salaryPlanFormulaId);


    /**
     * 查询工资方案计算公式及条件
     * @param salaryPlanFormulaQuery 工资方案计算公式及条件查询参数
     * @return page
     */
    @ApiOperation(value="查询工资方案计算公式及条件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryPlanFormulaQuery", dataType = "SalaryPlanFormulaQuery", value = "工资方案计算公式及条件查询参数", paramType = "query")
    })
    Result<List<SalaryPlanFormulaListVO>> listAll(SalaryPlanFormulaQuery salaryPlanFormulaQuery);


     /**
     * 分页查询工资方案计算公式及条件
     * @param salaryPlanFormulaQuery 工资方案计算公式及条件查询参数
     * @return page
     */
    @ApiOperation(value="分页查询工资方案计算公式及条件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryPlanFormulaQuery", dataType = "SalaryPlanFormulaQuery", value = "工资方案计算公式及条件查询参数", paramType = "query")
    })
    Result<Page<SalaryPlanFormulaListVO>> page(SalaryPlanFormulaQuery salaryPlanFormulaQuery);


}

